WorkflowManagerAPI Methods
An object defining methods for the WorkflowManagerAPI class.
GetUserApprovalCounts(telemetryCollectorHolder)
Retrieves the count of user approvals.
Parameters:
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the approval count retrieval process.
Returns:
Type: Task<WrapResponse, IEnumerable<WorkflowItem>>
Returns a wrapped response containing the count of user approvals.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
StartWorkflow(projectName, flowName, eventId, documentName, documentValues, documentOptions, telemetryCollectorHolder)
Creates a workflow instance and if an event is specified, continues its execution based on that event.
Parameters:
projectName (required): string
Represents the project for which the instance will be created.
flowName (required): string
Represents the flow for which the instance will be created.
eventId (required): int?
The event ID to start the workflow with.
documentName (required): string
The documentName represents the document in which the given documentValues will be implemented.
documentValues (required): Dictionary<string, object>
A dictionary where each key is a string representing the component name on the form, and each value is an object representing the value assigned to that component. If no changes are needed to the document objects, this can be left empty.
documentOptions (required): List<StartParametersDocumentOption>
A list that holds document objects' IDs, names, and view information.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.
Returns:
Type: Task<FlowSaveAndContinueResponse>
Returns the response of the workflow save and continue operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetUserApprovals(projectName, loadOptions, telemetryCollectorHolder)
Retrieves user approvals for the specified project.
Parameters:
projectName (required): string
The name of the project.
loadOptions (required): LoadOptions
Options for loading the approvals.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the approval retrieval process.
Returns:
Type: Task<WrapResponse, List<UserApprove>>
Returns a wrapped response containing the list of user approvals.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Create(initialOptions, telemetryCollectorHolder)
Creates a new workflow instance with the specified initial options.
Parameters:
initialOptions (required): InitialOptions
The options for initializing the workflow instance.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the workflow creation process.
Returns:
Type: Task<WorkflowInstance>
Returns the created workflow instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Create(projectName, flowName, documentOptions, processId, requestId, telemetryCollectorHolder)
The Create method is used to provide access to an instance of a specific flow.
Parameters:
projectName (required): string
Represents the project for which the instance will be created.
flowName (required): string
Represents the flow for which the instance will be created.
documentOptions (required): List<StartParametersDocumentOption>
A list that holds document objects' IDs, names, and view information.
processId (optional): long
Represents the process for which the instance will be created. If the value is set to 0, it will operate on the most recent process.
requestId (optional): long
Represents the request for which the instance will be created. Optional; if null, it will operate on the latest request of the process.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.
Returns:
Type: Task<WorkflowInstance>
Returns the workflow instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
StartWorkflow(projectName, flowName, documentOptions, eventId, telemetryCollectorHolder)
Creates a workflow instance and if an event is specified, continues its execution based on that event.
Parameters:
projectName (required): string
Represents the project for which the instance will be created.
flowName (required): string
Represents the flow for which the instance will be created.
documentOptions (required): List<StartParametersDocumentOption>
A list that holds document objects' IDs, names, and view information.
eventId (optional): int?
The event ID to start the workflow with.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.
Returns:
Type: Task<FlowStartResponse>
Returns the response of the workflow start operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetUserFlowApprovals(projectName, flowName, loadOptions, telemetryCollectorHolder)
Retrieves user flow approvals for the specified project and flow.
Parameters:
projectName (required): string
The name of the project.
flowName (required): string
The name of the flow.
loadOptions (required): LoadOptions
Options for loading the flow approvals.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the flow approval retrieval process.
Returns:
Type: Task<WrapResponse, IEnumerable<UserApprovals>>
Returns a wrapped response containing the list of user flow approvals.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
Create(projectName, flowName, processId, requestId, telemetryCollectorHolder)
The Create method is used to provide access to an instance of a specific flow.
Parameters:
projectName (required): string
Represents the project for which the instance will be created.
flowName (required): string
Represents the flow for which the instance will be created.
processId (optional): long
Represents the process for which the instance will be created. If the value is set to 0, it will operate on the most recent process.
requestId (optional): long
Represents the request for which the instance will be created. Optional; if null, it will operate on the latest request of the process.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.
Returns:
Type: Task<WorkflowInstance>
Returns the workflow instance.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
DeleteProcess(processId, telemetryCollectorHolder)
Deletes the specified process.
Parameters:
processId (required): long
The ID of the process to delete.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the process deletion.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether the process was successfully deleted.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
ContinueWorkflow(projectName, flowName, processId, eventId, telemetryCollectorHolder)
Continues a workflow with the specified project and flow names.
Parameters:
projectName (required): string
The name of the project.
flowName (required): string
The name of the flow.
processId (required): long
The ID of the process to continue.
eventId (required): int
The event ID to continue the workflow with.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the workflow continuation process.
Returns:
Type: Task<FlowContinueResponse>
Returns the response of the workflow continuation operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
StartWorkflow(projectName, flowName, eventId, telemetryCollectorHolder)
Starts a workflow with the specified project and flow names.
Parameters:
projectName (required): string
The name of the project.
flowName (required): string
The name of the flow.
eventId (optional): int?
The event ID to start the workflow with.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the workflow start process.
Returns:
Type: Task<FlowStartResponse>
Returns the response of the workflow start operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
ContinueWorkflow(projectName, flowName, processId, eventId, documentName, documentValues, telemetryCollectorHolder)
Continues a workflow with the specified project and flow names, updating document values.
Parameters:
projectName (required): string
The name of the project.
flowName (required): string
The name of the flow.
processId (required): long
The ID of the process to continue.
eventId (required): int
The event ID to continue the workflow with.
documentName (required): string
The name of the document to update.
documentValues (optional): Dictionary<string, object>
The values to update in the document.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the workflow continuation process.
Returns:
Type: Task<FlowSaveAndContinueResponse>
Returns the response of the workflow continuation operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetCurrentProcessRequest(documentId, userId, telemetryCollectorHolder)
Retrieves the current process request for the specified document and user.
Parameters:
documentId (required): long
The ID of the document.
userId (required): int
The ID of the user.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the process request retrieval.
Returns:
Type: Task<WrapResponse<GetCurrentProcessRequestResponse>>
Returns a wrapped response containing the current process request.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
HasWaitingApprovalRequestForUser(processId, userId, telemetryCollectorHolder)
Checks if there is a waiting approval request for the specified user and process.
Parameters:
processId (required): long
The ID of the process.
userId (required): int
The ID of the user.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the check process.
Returns:
Type: Task<WrapResponse<bool>>
Returns a wrapped response indicating whether there is a waiting approval request.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetDocumentProcessId(documentId, telemetryCollectorHolder)
Retrieves the process ID for the specified document.
Parameters:
documentId (required): long
The ID of the document.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the process ID retrieval.
Returns:
Type: Task<WrapResponse<GetDocumentProcessResponse>>
Returns a wrapped response containing the process ID for the document.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
GetWaitingProcessRequests(processId, telemetryCollectorHolder)
Retrieves the waiting process requests for the specified process.
Parameters:
processId (required): long
The ID of the process.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the process request retrieval.
Returns:
Type: Task<WrapResponse, IEnumerable<ProcessRequestItemDetail>>
Returns a wrapped response containing the waiting process requests.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
StartWorkflow(projectName, flowName, eventId, documentName, documentValues, telemetryCollectorHolder)
Creates a workflow instance and if an event is specified, continues its execution based on that event.
Parameters:
projectName (required): string
Represents the project for which the instance will be created.
flowName (required): string
Represents the flow for which the instance will be created.
eventId (required): int?
The event ID to start the workflow with.
documentName (required): string
The documentName represents the document in which the given documentValues will be implemented.
documentValues (required): Dictionary<string, object>
A dictionary where each key is a string representing the component name on the form, and each value is an object representing the value assigned to that component. If no changes are needed to the document objects, this can be left empty.
telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.
Returns:
Type: Task<FlowSaveAndContinueResponse>
Returns the response of the workflow save and continue operation.
This is a async method. Method should be waited. Be careful if call this method without waiting.